solver.datamodel.preferences.Graphics#
- class ansys.fluent.core.datamodel_231.preferences.Root.Graphics#
Bases:
PyMenuSingleton Graphics.
Classes:
Parameter AnimationOption of value type str.
Singleton BoundaryMarkers.
Singleton ColormapSettings.
Parameter DoubleBuffering of value type bool.
Singleton EmbeddedWindows.
Parameter EnableNonObjectBasedWorkflow of value type bool.
Parameter EventPollInterval of value type int.
Parameter EventPollTimeout of value type int.
Singleton ExportVideoSettings.
Parameter ForceKeyFrameAnimationMarkersToOff of value type bool.
Singleton GraphicsEffects.
Parameter GraphicsWindowLineWidth of value type str.
Parameter GraphicsWindowPointSymbol of value type str.
Singleton HardcopySettings.
Parameter HiddenSurfaceRemovalMethod of value type str.
Parameter HigherResolutionGraphicsWindowLineWidth of value type float.
Singleton Lighting.
Parameter LowerResolutionGraphicsWindowLineWidth of value type float.
Singleton ManageHoopsMemory.
Parameter MarkerDrawingMode of value type str.
Singleton MaterialEffects.
Parameter MaxGraphicsTextSize of value type int.
Singleton MeshingMode.
Parameter MinGraphicsTextSize of value type int.
Singleton Performance.
Parameter PlotLegendMargin of value type float.
Parameter PointToolSize of value type float.
Parameter RemovePartitionLines of value type bool.
Parameter RemovePartitionLinesTolerance of value type float.
Parameter RotationCenterpointVisible of value type bool.
Parameter ScrollWheelEventEndTimer of value type int.
Parameter SetCameraNormalToSurfaceIncrements of value type int.
Parameter ShowHiddenLines of value type bool.
Parameter ShowHiddenSurfaces of value type bool.
Parameter SwitchToOpenGLForRemoteVisualization of value type bool.
Parameter TestUseExternalFunction of value type str.
Parameter TextWindowLineWidth of value type str.
Singleton Transparency.
Singleton VectorSettings.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class AnimationOption#
Bases:
PyTextualParameter AnimationOption of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class BoundaryMarkers#
Bases:
PyMenuSingleton BoundaryMarkers.
Classes:
Parameter ColorOption of value type str.
Parameter Enabled of value type bool.
Parameter ExcludeFromBounding of value type bool.
Parameter InletColor of value type str.
Parameter MarkerFraction of value type float.
Parameter MarkerSizeLimitingScaleMultiplier of value type float.
Parameter MarkersLimit of value type int.
Parameter OutletColor of value type str.
Parameter ScaleMarker of value type float.
Parameter ShowInletMarkers of value type bool.
Parameter ShowOutletMarkers of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class ColorOption#
Bases:
PyTextualParameter ColorOption of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Enabled#
Bases:
PyParameterParameter Enabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ExcludeFromBounding#
Bases:
PyParameterParameter ExcludeFromBounding of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class InletColor#
Bases:
PyTextualParameter InletColor of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class MarkerFraction#
Bases:
PyNumericalParameter MarkerFraction of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MarkerSizeLimitingScaleMultiplier#
Bases:
PyNumericalParameter MarkerSizeLimitingScaleMultiplier of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MarkersLimit#
Bases:
PyNumericalParameter MarkersLimit of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class OutletColor#
Bases:
PyTextualParameter OutletColor of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ScaleMarker#
Bases:
PyNumericalParameter ScaleMarker of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class ShowInletMarkers#
Bases:
PyParameterParameter ShowInletMarkers of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShowOutletMarkers#
Bases:
PyParameterParameter ShowOutletMarkers of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class ColormapSettings#
Bases:
PyMenuSingleton ColormapSettings.
Classes:
Parameter Alignment of value type str.
Parameter AspectRatioWhenHorizontal of value type float.
Parameter AspectRatioWhenVertical of value type float.
Parameter AutoRefitOnResize of value type bool.
Parameter AutomaticResize of value type bool.
Parameter BorderStyle of value type str.
Parameter Colormap of value type str.
Parameter IsolinesPositionOffset of value type float.
Parameter Labels of value type bool.
Parameter Levels of value type int.
Parameter LogScale of value type bool.
Parameter MajorLengthToScreenRatioWhenHorizontal of value type float.
Parameter MajorLengthToScreenRatioWhenVertical of value type float.
Parameter MarginFromEdgeToScreenRatio of value type float.
Parameter MaxSizeScaleFactor of value type float.
Parameter MinSizeScaleFactor of value type float.
Parameter NumberFormatPrecision of value type int.
Parameter NumberFormatType of value type str.
Parameter PreserveAspectRatioForHardcopy of value type bool.
Parameter ShowColormap of value type bool.
Parameter SkipValue of value type int.
Parameter TextBehavior of value type str.
Parameter TextFontAutomaticHorizontalSize of value type float.
Parameter TextFontAutomaticSize of value type float.
Parameter TextFontAutomaticUnits of value type str.
Parameter TextFontAutomaticVerticalSize of value type float.
Parameter TextFontFixedHorizontalSize of value type int.
Parameter TextFontFixedSize of value type int.
Parameter TextFontFixedUnits of value type str.
Parameter TextFontFixedVerticalSize of value type int.
Parameter TextFontName of value type str.
Parameter TextTruncationLimitForHorizontalColormaps of value type int.
Parameter TextTruncationLimitForVerticalColormaps of value type int.
Parameter Type of value type str.
Parameter UseNoSubWindows of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class Alignment#
Bases:
PyTextualParameter Alignment of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class AspectRatioWhenHorizontal#
Bases:
PyNumericalParameter AspectRatioWhenHorizontal of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class AspectRatioWhenVertical#
Bases:
PyNumericalParameter AspectRatioWhenVertical of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class AutoRefitOnResize#
Bases:
PyParameterParameter AutoRefitOnResize of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class AutomaticResize#
Bases:
PyParameterParameter AutomaticResize of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class BorderStyle#
Bases:
PyTextualParameter BorderStyle of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Colormap#
Bases:
PyTextualParameter Colormap of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class IsolinesPositionOffset#
Bases:
PyNumericalParameter IsolinesPositionOffset of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Labels#
Bases:
PyParameterParameter Labels of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Levels#
Bases:
PyNumericalParameter Levels of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class LogScale#
Bases:
PyParameterParameter LogScale of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class MajorLengthToScreenRatioWhenHorizontal#
Bases:
PyNumericalParameter MajorLengthToScreenRatioWhenHorizontal of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MajorLengthToScreenRatioWhenVertical#
Bases:
PyNumericalParameter MajorLengthToScreenRatioWhenVertical of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MarginFromEdgeToScreenRatio#
Bases:
PyNumericalParameter MarginFromEdgeToScreenRatio of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MaxSizeScaleFactor#
Bases:
PyNumericalParameter MaxSizeScaleFactor of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MinSizeScaleFactor#
Bases:
PyNumericalParameter MinSizeScaleFactor of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class NumberFormatPrecision#
Bases:
PyNumericalParameter NumberFormatPrecision of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class NumberFormatType#
Bases:
PyTextualParameter NumberFormatType of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class PreserveAspectRatioForHardcopy#
Bases:
PyParameterParameter PreserveAspectRatioForHardcopy of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShowColormap#
Bases:
PyParameterParameter ShowColormap of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SkipValue#
Bases:
PyNumericalParameter SkipValue of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextBehavior#
Bases:
PyTextualParameter TextBehavior of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TextFontAutomaticHorizontalSize#
Bases:
PyNumericalParameter TextFontAutomaticHorizontalSize of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextFontAutomaticSize#
Bases:
PyNumericalParameter TextFontAutomaticSize of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextFontAutomaticUnits#
Bases:
PyTextualParameter TextFontAutomaticUnits of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TextFontAutomaticVerticalSize#
Bases:
PyNumericalParameter TextFontAutomaticVerticalSize of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextFontFixedHorizontalSize#
Bases:
PyNumericalParameter TextFontFixedHorizontalSize of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextFontFixedSize#
Bases:
PyNumericalParameter TextFontFixedSize of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextFontFixedUnits#
Bases:
PyTextualParameter TextFontFixedUnits of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TextFontFixedVerticalSize#
Bases:
PyNumericalParameter TextFontFixedVerticalSize of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextFontName#
Bases:
PyTextualParameter TextFontName of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TextTruncationLimitForHorizontalColormaps#
Bases:
PyNumericalParameter TextTruncationLimitForHorizontalColormaps of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TextTruncationLimitForVerticalColormaps#
Bases:
PyNumericalParameter TextTruncationLimitForVerticalColormaps of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Type#
Bases:
PyTextualParameter Type of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class UseNoSubWindows#
Bases:
PyParameterParameter UseNoSubWindows of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class DoubleBuffering#
Bases:
PyParameterParameter DoubleBuffering of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class EmbeddedWindows#
Bases:
PyMenuSingleton EmbeddedWindows.
Classes:
Parameter DefaultEmbeddedMeshWindowsView of value type bool.
Parameter DefaultEmbeddedWindowsView of value type bool.
Parameter SaveEmbeddedWindowLayout of value type bool.
Parameter ShowBorderForEmbeddedWindow of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class DefaultEmbeddedMeshWindowsView#
Bases:
PyParameterParameter DefaultEmbeddedMeshWindowsView of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class DefaultEmbeddedWindowsView#
Bases:
PyParameterParameter DefaultEmbeddedWindowsView of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SaveEmbeddedWindowLayout#
Bases:
PyParameterParameter SaveEmbeddedWindowLayout of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShowBorderForEmbeddedWindow#
Bases:
PyParameterParameter ShowBorderForEmbeddedWindow of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class EnableNonObjectBasedWorkflow#
Bases:
PyParameterParameter EnableNonObjectBasedWorkflow of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class EventPollInterval#
Bases:
PyNumericalParameter EventPollInterval of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class EventPollTimeout#
Bases:
PyNumericalParameter EventPollTimeout of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class ExportVideoSettings#
Bases:
PyMenuSingleton ExportVideoSettings.
Classes:
Singleton AdvancedVideoQualityOptions.
Parameter VideoFPS of value type int.
Parameter VideoFormat of value type str.
Parameter VideoQuality of value type str.
Parameter VideoResoutionX of value type int.
Parameter VideoResoutionY of value type int.
Parameter VideoScale of value type str.
Parameter VideoSmoothScaling of value type bool.
Parameter VideoUseFrameResolution of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class AdvancedVideoQualityOptions#
Bases:
PyMenuSingleton AdvancedVideoQualityOptions.
Classes:
Parameter BitRateQuality of value type str.
Parameter Bitrate of value type int.
Parameter CompressionMethod of value type str.
Parameter EnableH264 of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class BitRateQuality#
Bases:
PyTextualParameter BitRateQuality of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Bitrate#
Bases:
PyNumericalParameter Bitrate of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class CompressionMethod#
Bases:
PyTextualParameter CompressionMethod of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class EnableH264#
Bases:
PyParameterParameter EnableH264 of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class VideoFPS#
Bases:
PyNumericalParameter VideoFPS of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class VideoFormat#
Bases:
PyTextualParameter VideoFormat of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class VideoQuality#
Bases:
PyTextualParameter VideoQuality of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class VideoResoutionX#
Bases:
PyNumericalParameter VideoResoutionX of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class VideoResoutionY#
Bases:
PyNumericalParameter VideoResoutionY of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class VideoScale#
Bases:
PyTextualParameter VideoScale of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class VideoSmoothScaling#
Bases:
PyParameterParameter VideoSmoothScaling of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class VideoUseFrameResolution#
Bases:
PyParameterParameter VideoUseFrameResolution of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class ForceKeyFrameAnimationMarkersToOff#
Bases:
PyParameterParameter ForceKeyFrameAnimationMarkersToOff of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class GraphicsEffects#
Bases:
PyMenuSingleton GraphicsEffects.
Classes:
Parameter AmbientOcclusionEnabled of value type bool.
Parameter AmbientOcclusionQuality of value type str.
Parameter AmbientOcclusionStrength of value type int.
Parameter AntiAliasing of value type bool.
Parameter BloomBlur of value type int.
Parameter BloomEnabled of value type bool.
Parameter BloomStrength of value type int.
Parameter GridColor of value type str.
Parameter GridPlaneCount of value type int.
Parameter GridPlaneEnabled of value type bool.
Parameter GridPlaneOffset of value type int.
Parameter GridPlaneSizeFactor of value type int.
Parameter PlaneDirection of value type str.
Parameter ReflectionsEnabled of value type bool.
Parameter ShadowMapEnabled of value type bool.
Parameter ShowEdgeReflections of value type bool.
Parameter ShowMarkerReflections of value type bool.
Parameter SimpleShadowsEnabled of value type bool.
Parameter UpdateAfterMouseRelease of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class AmbientOcclusionEnabled#
Bases:
PyParameterParameter AmbientOcclusionEnabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class AmbientOcclusionQuality#
Bases:
PyTextualParameter AmbientOcclusionQuality of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class AmbientOcclusionStrength#
Bases:
PyNumericalParameter AmbientOcclusionStrength of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class AntiAliasing#
Bases:
PyParameterParameter AntiAliasing of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class BloomBlur#
Bases:
PyNumericalParameter BloomBlur of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class BloomEnabled#
Bases:
PyParameterParameter BloomEnabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class BloomStrength#
Bases:
PyNumericalParameter BloomStrength of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class GridColor#
Bases:
PyTextualParameter GridColor of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class GridPlaneCount#
Bases:
PyNumericalParameter GridPlaneCount of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class GridPlaneEnabled#
Bases:
PyParameterParameter GridPlaneEnabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class GridPlaneOffset#
Bases:
PyNumericalParameter GridPlaneOffset of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class GridPlaneSizeFactor#
Bases:
PyNumericalParameter GridPlaneSizeFactor of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class PlaneDirection#
Bases:
PyTextualParameter PlaneDirection of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ReflectionsEnabled#
Bases:
PyParameterParameter ReflectionsEnabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShadowMapEnabled#
Bases:
PyParameterParameter ShadowMapEnabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShowEdgeReflections#
Bases:
PyParameterParameter ShowEdgeReflections of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShowMarkerReflections#
Bases:
PyParameterParameter ShowMarkerReflections of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SimpleShadowsEnabled#
Bases:
PyParameterParameter SimpleShadowsEnabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class UpdateAfterMouseRelease#
Bases:
PyParameterParameter UpdateAfterMouseRelease of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class GraphicsWindowLineWidth#
Bases:
PyTextualParameter GraphicsWindowLineWidth of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class GraphicsWindowPointSymbol#
Bases:
PyTextualParameter GraphicsWindowPointSymbol of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class HardcopySettings#
Bases:
PyMenuSingleton HardcopySettings.
Classes:
Parameter ExportEdgesForAVZ of value type bool.
Parameter HardcopyDriver of value type str.
Parameter HardcopyLineWidth of value type int.
Parameter HardwareImageAccel of value type bool.
Parameter PostScriptPermissionOverride of value type bool.
Parameter SaveEmbeddedHardcopiesSeparately of value type bool.
Parameter SaveEmbeddedWindowsInHardcopy of value type bool.
Parameter TransparentEmbeddedWindows of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class ExportEdgesForAVZ#
Bases:
PyParameterParameter ExportEdgesForAVZ of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class HardcopyDriver#
Bases:
PyTextualParameter HardcopyDriver of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class HardcopyLineWidth#
Bases:
PyNumericalParameter HardcopyLineWidth of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class HardwareImageAccel#
Bases:
PyParameterParameter HardwareImageAccel of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class PostScriptPermissionOverride#
Bases:
PyParameterParameter PostScriptPermissionOverride of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SaveEmbeddedHardcopiesSeparately#
Bases:
PyParameterParameter SaveEmbeddedHardcopiesSeparately of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SaveEmbeddedWindowsInHardcopy#
Bases:
PyParameterParameter SaveEmbeddedWindowsInHardcopy of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TransparentEmbeddedWindows#
Bases:
PyParameterParameter TransparentEmbeddedWindows of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class HiddenSurfaceRemovalMethod#
Bases:
PyTextualParameter HiddenSurfaceRemovalMethod of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class HigherResolutionGraphicsWindowLineWidth#
Bases:
PyNumericalParameter HigherResolutionGraphicsWindowLineWidth of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Lighting#
Bases:
PyMenuSingleton Lighting.
Classes:
Parameter AmbientLightIntensity of value type float.
Parameter Headlight of value type str.
Parameter HeadlightIntensity of value type float.
Parameter LightingMethod of value type str.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class AmbientLightIntensity#
Bases:
PyNumericalParameter AmbientLightIntensity of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Headlight#
Bases:
PyTextualParameter Headlight of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class HeadlightIntensity#
Bases:
PyNumericalParameter HeadlightIntensity of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class LightingMethod#
Bases:
PyTextualParameter LightingMethod of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class LowerResolutionGraphicsWindowLineWidth#
Bases:
PyNumericalParameter LowerResolutionGraphicsWindowLineWidth of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class ManageHoopsMemory#
Bases:
PyMenuSingleton ManageHoopsMemory.
Classes:
Parameter Enabled of value type bool.
Parameter HSFImportLimit of value type int.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class Enabled#
Bases:
PyParameterParameter Enabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class HSFImportLimit#
Bases:
PyNumericalParameter HSFImportLimit of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class MarkerDrawingMode#
Bases:
PyTextualParameter MarkerDrawingMode of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class MaterialEffects#
Bases:
PyMenuSingleton MaterialEffects.
Classes:
Parameter DecimationFilter of value type str.
Parameter ParameterizationSource of value type str.
Parameter TilingStyle of value type str.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class DecimationFilter#
Bases:
PyTextualParameter DecimationFilter of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ParameterizationSource#
Bases:
PyTextualParameter ParameterizationSource of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TilingStyle#
Bases:
PyTextualParameter TilingStyle of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class MaxGraphicsTextSize#
Bases:
PyNumericalParameter MaxGraphicsTextSize of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MeshingMode#
Bases:
PyMenuSingleton MeshingMode.
Classes:
Parameter GraphicsWindowDisplayTimeout of value type bool.
Parameter GraphicsWindowDisplayTimeoutValue of value type float.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class GraphicsWindowDisplayTimeout#
Bases:
PyParameterParameter GraphicsWindowDisplayTimeout of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class GraphicsWindowDisplayTimeoutValue#
Bases:
PyNumericalParameter GraphicsWindowDisplayTimeoutValue of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class MinGraphicsTextSize#
Bases:
PyNumericalParameter MinGraphicsTextSize of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Performance#
Bases:
PyMenuSingleton Performance.
Classes:
Singleton FastDisplayMode.
Singleton MinimumFrameRate.
Parameter OptimizeFor of value type str.
Parameter RatioOfTargetFrameRateToClassifyHeavyGeometry of value type float.
Parameter RatioOfTargetFrameRateToDeclassifyHeavyGeometry of value type float.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class FastDisplayMode#
Bases:
PyMenuSingleton FastDisplayMode.
Classes:
Parameter Culling of value type int.
Parameter FacesShown of value type bool.
Parameter MarkersDecimation of value type float.
Parameter NodesShown of value type bool.
Parameter PerimeterEdgesShown of value type bool.
Parameter SilhouetteShown of value type bool.
Parameter Status of value type str.
Parameter Transparency of value type bool.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class Culling#
Bases:
PyNumericalParameter Culling of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class FacesShown#
Bases:
PyParameterParameter FacesShown of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class MarkersDecimation#
Bases:
PyNumericalParameter MarkersDecimation of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class NodesShown#
Bases:
PyParameterParameter NodesShown of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class PerimeterEdgesShown#
Bases:
PyParameterParameter PerimeterEdgesShown of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SilhouetteShown#
Bases:
PyParameterParameter SilhouetteShown of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Status#
Bases:
PyTextualParameter Status of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Transparency#
Bases:
PyParameterParameter Transparency of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class MinimumFrameRate#
Bases:
PyMenuSingleton MinimumFrameRate.
Classes:
Parameter DynamicAdjustment of value type bool.
Parameter Enabled of value type bool.
Parameter FixedCullingValue of value type int.
Parameter MaximumCullingThreshold of value type int.
Parameter MinimumCullingThreshold of value type int.
Parameter TargetFPS of value type int.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class DynamicAdjustment#
Bases:
PyParameterParameter DynamicAdjustment of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Enabled#
Bases:
PyParameterParameter Enabled of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class FixedCullingValue#
Bases:
PyNumericalParameter FixedCullingValue of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MaximumCullingThreshold#
Bases:
PyNumericalParameter MaximumCullingThreshold of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class MinimumCullingThreshold#
Bases:
PyNumericalParameter MinimumCullingThreshold of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class TargetFPS#
Bases:
PyNumericalParameter TargetFPS of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class OptimizeFor#
Bases:
PyTextualParameter OptimizeFor of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class RatioOfTargetFrameRateToClassifyHeavyGeometry#
Bases:
PyNumericalParameter RatioOfTargetFrameRateToClassifyHeavyGeometry of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class RatioOfTargetFrameRateToDeclassifyHeavyGeometry#
Bases:
PyNumericalParameter RatioOfTargetFrameRateToDeclassifyHeavyGeometry of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class PlotLegendMargin#
Bases:
PyNumericalParameter PlotLegendMargin of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class PointToolSize#
Bases:
PyNumericalParameter PointToolSize of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class RemovePartitionLines#
Bases:
PyParameterParameter RemovePartitionLines of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class RemovePartitionLinesTolerance#
Bases:
PyNumericalParameter RemovePartitionLinesTolerance of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class RotationCenterpointVisible#
Bases:
PyParameterParameter RotationCenterpointVisible of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ScrollWheelEventEndTimer#
Bases:
PyNumericalParameter ScrollWheelEventEndTimer of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class SetCameraNormalToSurfaceIncrements#
Bases:
PyNumericalParameter SetCameraNormalToSurfaceIncrements of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class ShowHiddenLines#
Bases:
PyParameterParameter ShowHiddenLines of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ShowHiddenSurfaces#
Bases:
PyParameterParameter ShowHiddenSurfaces of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class SwitchToOpenGLForRemoteVisualization#
Bases:
PyParameterParameter SwitchToOpenGLForRemoteVisualization of value type bool.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TestUseExternalFunction#
Bases:
PyTextualParameter TestUseExternalFunction of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class TextWindowLineWidth#
Bases:
PyTextualParameter TextWindowLineWidth of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class Transparency#
Bases:
PyMenuSingleton Transparency.
Classes:
Parameter AlgorithmForModernDrivers of value type str.
Parameter DepthPeelingLayers of value type int.
Parameter DepthPeelingPreference of value type str.
Parameter QuickMoves of value type str.
Parameter ZSortOptions of value type str.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class AlgorithmForModernDrivers#
Bases:
PyTextualParameter AlgorithmForModernDrivers of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class DepthPeelingLayers#
Bases:
PyNumericalParameter DepthPeelingLayers of value type int.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class DepthPeelingPreference#
Bases:
PyTextualParameter DepthPeelingPreference of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class QuickMoves#
Bases:
PyTextualParameter QuickMoves of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- class ZSortOptions#
Bases:
PyTextualParameter ZSortOptions of value type str.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- allowed_values()#
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- class VectorSettings#
Bases:
PyMenuSingleton VectorSettings.
Classes:
Parameter Arrow3DRadius1Factor of value type float.
Parameter Arrow3DRadius2Factor of value type float.
Parameter Arrowhead3DRadius1Factor of value type float.
Parameter LineArrow3DPerpendicularRadius of value type float.
Methods:
__init__(service, rules, path)__init__ method of PyMenu class.
add_on_affected(cb)Register a callback for when the object is affected.
add_on_affected_at_type_path(child_type, cb)Register a callback for when the object is affected at child type
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
add_on_child_created(child_type, cb)Register a callback for when a child object is created.
add_on_command_attribute_changed(command, ...)Register a callback for when an attribute is changed
create_command_arguments(command)Create command arguments.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
name()Get the name of the named object.
rename(new_name)Rename the named object.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- class Arrow3DRadius1Factor#
Bases:
PyNumericalParameter Arrow3DRadius1Factor of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Arrow3DRadius2Factor#
Bases:
PyNumericalParameter Arrow3DRadius2Factor of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class Arrowhead3DRadius1Factor#
Bases:
PyNumericalParameter Arrowhead3DRadius1Factor of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- class LineArrow3DPerpendicularRadius#
Bases:
PyNumericalParameter LineArrow3DPerpendicularRadius of value type float.
Methods:
__init__(service, rules[, path])__init__ method of PyStateContainer class.
add_on_attribute_changed(attribute, cb)Register a callback for when an attribute is changed
add_on_changed(cb)Register a callback for when the object is modified.
Get default value of the parameter.
getAttribValue(attrib)Get attribute value of the current object.
getState()Get state of the current object.
get_attr(attrib)Get attribute value of the current object.
Get state of the current object.
help()Print help string.
Returns true if the parameter is active.
Checks whether the parameter is read only.
max()Maximum value of the numerical parameter.
min()Minimum value of the numerical parameter.
setState([state])Set state of the current object.
set_state([state])Set state of the current object.
Attributes:
- __init__(service, rules, path=None)#
__init__ method of PyStateContainer class.
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- default_value()#
Get default value of the parameter.
- docstring = None#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- is_read_only()#
Checks whether the parameter is read only.
- max()#
Maximum value of the numerical parameter.
- min()#
Minimum value of the numerical parameter.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.
- __init__(service, rules, path)#
__init__ method of PyMenu class.
- add_on_affected(cb)#
Register a callback for when the object is affected.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_affected_at_type_path(child_type, cb)#
Register a callback for when the object is affected at child type
- Parameters:
- child_type
str child type
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_attribute_changed(attribute, cb)#
Register a callback for when an attribute is changed
- Parameters:
- attribute
str attribute name
- cb
Callable Callback function
- attribute
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_changed(cb)#
Register a callback for when the object is modified.
- Parameters:
- cb
Callable Callback function
- cb
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_child_created(child_type, cb)#
Register a callback for when a child object is created.
- Parameters:
- child_type
str Type of the child object
- cb
Callable Callback function
- child_type
- Returns:
EventSubscriptionEventSubscription instance which can be used to unregister the callback
- Return type:
EventSubscription
- add_on_command_attribute_changed(command, attribute, cb)#
Register a callback for when an attribute is changed
- create_command_arguments(command)#
Create command arguments.
- delete_all_child_objects()#
- delete_child()#
- delete_child_objects()#
- docstring = None#
- fix_state()#
- getAttribValue(attrib)#
Get attribute value of the current object.
- get_attr(attrib)#
Get attribute value of the current object.
- is_active()#
Returns true if the parameter is active.
- name()#
Get the name of the named object.
- rename(new_name)#
Rename the named object.